OpenEdge Application Server:<br />Administration Preface

This manual provides a central point of reference for configuring and managing the following OpenEdge® Application Server products and OpenEdge adapters:

All of these products and adapters share one or more of the following common features:

Audience

This manual is for you if you need to configure and manage any of the OpenEdge Application Server products and OpenEdge adapters that it features. This manual is also for you if you need to deploy AppServer applications, WebSpeed applications, Progress 4GL applications that include JMS messaging using SonicMQ, or if you need to deploy Progress 4GL Web services within the OpenEdge or Sonic ESB environment. For more information on these products and adapters, see OpenEdge Getting Started: Application and Integration Services . For most of these products and components it is helpful to be familiar with the Progress Explorer framework. For more information on this framework, see OpenEdge Getting Started: Installation and Configuration .

Organization

Introduces the OpenEdge server and adapter products who’s management is described in this manual, and provides references for more information on product architecture and usage.

Describes the components, tools, and procedures for managing an AppServer installation.

Describes the components, tools, and procedures for managing an AppServer Internet Adapter installation.

Describes the basic features of Web Services Adapter (WSA) management and some post installation configuration tasks.

Describes how to create and manage a WSA Web application in the context of a Java servlet engine (JSE), how to create and manage WSA servlets in the context of a WSA Web application, and how to create and manage corresponding WSA instances in the context of the OpenEdge environment using the Progress Explorer framework.

Describes how to deploy and manage Progress 4GL Web services in the context of a single WSA instance, and how to export and import Web services between WSA instances.

Describes the components of WSA security and how to create and manage common WSA security configurations, listed for reference by alphabetical order.

Introduces the WSAMAN command-line utility to perform many of the WSA and Web service management tasks that are otherwise performed using the Progress Explorer GUI.

Describes the basic requirements and procedures for configuring a WebSpeed installation in the Windows environment.

Describes the basic requirements and procedures for configuring a WebSpeed installation in the UNIX environment.

Describes how to manage dynamic code-page support for internationalizing WebSpeed installations.

Describes how to connect a WebSpeed application to an OpenEdge data source, such an OpenEdge RDBMS or DataServer.

Describes the components of WebSpeed security and how to use them to manage secure WebSpeed installations and applications.

Describes how to manage a WebSpeed installation to incorporate Microsoft Active Server Pages (ASP) in a WebSpeed application.

Describes the components, tools, and procedures for managing a SonicMQ Adapter installation to provide Java Message Service (JMS) messaging for a Progress 4GL client of a SonicMQ JMS.

Describes the components, tools, and procedures for managing Progress 4GL Web services as OpenEdge services installed and enabled through the Sonic ESB Adapter on the Sonic Enterprise Service Bus (Sonic ESB).

Describes how to access and provides an alphabetical reference to configuration and run-time properties used to manage both Progress 4GL Web services in the OpenEdge environment and OpenEdge services in the Sonic ESB environment.

Describes the syntax for commands and utilities documented in this manual. If this manual provides the primary documentation for a command or utility, the syntax for that command or utility appears in this appendix

Typographical conventions


Convention	Description
Bold	Bold typeface indicates commands or characters the user types, or the names of user interface elements.
Italic	Italic typeface indicates the title of a document, provides emphasis, or signifies new terms.
SMALL, BOLD CAPITAL LETTERS	Small, bold capital letters indicate OpenEdge® key functions and generic keyboard keys; for example, GET and CTRL.
KEY1+KEY2	A hyphen between key names indicates a simultaneous key sequence: you press and hold down the first key while pressing the second key. For example, CTRL+X.
KEY1 KEY2	A space between key names indicates a sequential key sequence: you press and release the first key, then press another key. For example, ESCAPE H.
Syntax:
`Fixed width`	A fixed-width font is used in syntax statements, code examples, and for system output and filenames.
`Fixed-width italics`	Fixed-width italics indicate variables in syntax statements.
`Fixed-width bold`	Fixed-width bold indicates variables with special emphasis.
UPPERCASE fixed width	Uppercase words are Progress® 4GL language keywords. Although these always are shown in uppercase, you can type them in either uppercase or lowercase in a procedure.
	This icon (three arrows) introduces a multi-step procedure.
	This icon (one arrow) introduces a single-step procedure.
Period (.) or colon (:)	All statements except `DO`, `FOR`, `FUNCTION`, `PROCEDURE`, and `REPEAT` end with a period. `DO`, `FOR`, `FUNCTION`, `PROCEDURE`, and `REPEAT` statements can end with either a period or a colon.
[ ]	Large brackets indicate the items within them are optional.
[ ]	Small brackets are part of the Progress 4GL language.
{ }	Large braces indicate the items within them are required. They are used to simplify complex syntax diagrams.
{ }	Small braces are part of the Progress 4GL language. For example, a called external procedure must use braces when referencing arguments passed by a calling procedure.
\|	A vertical bar indicates a choice.
...	Ellipses indicate repetition: you can choose one or more of the preceding items.

Examples of syntax descriptions

In this example, ACCUM is a keyword, and aggregate and expression are variables:

Syntax
ACCUM `aggregate expression`

FOR is one of the statements that can end with either a period or a colon, as in this example:

FOR EACH Customer: DISPLAY Name. END.

In this example, STREAM stream, UNLESS-HIDDEN, and NO-ERROR are optional:

In this example, the outer (small) brackets are part of the language, and the inner (large) brackets denote an optional item:

A called external procedure must use braces when referencing compile-time arguments passed by a calling procedure, as shown in this example:

Syntax
DISPLAY [ STREAM `stream` ] [ UNLESS-HIDDEN ] [ NO-ERROR ]

Syntax
INITIAL [ `constant` [ , `constant` ] ]

Syntax
{ `&argument-name` }

In this example, EACH, FIRST, and LAST are optional, but you can choose only one of them:

In this example, you must include two expressions, and optionally you can include more. Multiple expressions are separated by commas:

Syntax
PRESELECT [ EACH \| FIRST \| LAST ] `record-phrase`

Syntax
MAXIMUM ( `expression` , `expression` [ , `expression` ] ... )

In this example, you must specify MESSAGE and at least one expression or SKIP [ (n) ], and any number of additional expression or SKIP [ ( n ) ] is allowed:

Syntax
MESSAGE { `expression` \| SKIP [ ( `n` ) ] } ...

In this example, you must specify {include-file, then optionally any number of argument or &argument-name = "argument-value", and then terminate with }:

Long syntax descriptions split across lines

Some syntax descriptions are too long to fit on one line. When syntax descriptions are split across multiple lines, groups of optional and groups of required items are kept together in the required order.

Complex syntax descriptions with both required and optional elements

Some syntax descriptions are too complex to distinguish required and optional elements by bracketing only the optional elements. For such syntax, the descriptions include both braces (for required elements) and brackets (for optional elements).

Syntax
{ `include-file` [ `argument` \| `&argument-name = "argument-value"` ] ... }

Syntax
WITH [ ACCUM `max-length` ] [ `expression` DOWN ] [ CENTERED ] [ `n` COLUMNS ] [ SIDE-LABELS ] [ STREAM-IO ]

In this example, ASSIGN requires either one or more field entries or one record. Options available with field or record are grouped with braces and brackets:

Syntax
ASSIGN { [ FRAME `frame` ] { `field` [ = `expression` ] } [ WHEN `expression` ] } ... \| { `record` [ EXCEPT `field` ... ] }

OpenEdge messages

OpenEdge displays several types of messages to inform you of routine and unusual occurrences:

OpenEdge messages end with a message number in parentheses. In this example, the message number is 200:

If you encounter an error that terminates OpenEdge, note the message number before restarting.

Obtaining more information about OpenEdge messages

In Windows platforms, use OpenEdge online help to obtain more information about OpenEdge messages. Many OpenEdge tools include the following Help menu options to provide information about messages:

** Unknown table name `table.` (200)

On UNIX platforms, use the Progress pro command to start a single-user mode character OpenEdge client session and view a brief description of a message by providing its number.

Start the Progress Procedure Editor:


`install-dir`/dlc/bin/pro

Press F3 to access the menu bar, then choose Help

Messages.

Type the message number and press ENTER. Details about that message number appear.

Press F4 to close the message, press F3 to access the Progress Procedure Editor menu, and choose File

Exit.

Preface

Purpose